home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr33 / clock21.zip / CLOCK.DOC < prev   
Text File  |  1993-05-09  |  8KB  |  217 lines
  1. 
  2.  
  3.  
  4.  
  5.                         Documentation and Licence Agreement
  6.  
  7.      CLOCK.COM Version 2.1      Copyright (C) 1987       Brian O'Neill
  8.  
  9.                                                          April 1, 1988
  10.  
  11.      Description
  12.      ───────────
  13.  
  14.  
  15.        CLOCK.COM is a TSR real-time digital clock with a few features that
  16.        may commend it to your attention.  As of this writing, it has been in
  17.        use on several computers for two years; no reports of bugs or
  18.        incompatibilities with other TSRs have emerged.  In response to an
  19.        unexpected number of recent requests, and despite the late date
  20.        ("Just what the world needs: another real-time digital clock."), I am
  21.        releasing the program.
  22.  
  23.  
  24.        The present version (2.1) of CLOCK sports the following features:
  25.  
  26.                 *  both the clock colors and the clock location (screen
  27.                    coordinates) can be specified on the command line, and
  28.                    can also be queried with a command; the report(s) of
  29.                    its state take the form of the commands necessary to
  30.                    restore that state (more on this below);
  31.  
  32.                 *  CLOCK can be toggled with a hotkey (Alt-Shift-Ctrl-
  33.                    Esc);
  34.  
  35.                 *  when resident, CLOCK consumes only 757 bytes
  36.                    (not counting the size of the environment in force
  37.                    at the time of installation, which neither DOS nor
  38.                    CLOCK frees);
  39.  
  40.                 *  of course, it checks to see if it is already resident
  41.                    before installing itself, and will not install itself
  42.                    twice.
  43.  
  44.  
  45.      Hotkey
  46.      ──────
  47.  
  48.        The time display can be toggled on/off with Alt-Shift-Ctrl-Esc.
  49.        On "enhanced" (sic !) keyboards, either the lefthand or righthand
  50.        shift keys (i.e., all three of them) may be used.
  51.  
  52. 
  53.  
  54.  
  55.  
  56.      Syntax
  57.      ──────
  58.  
  59.        To install:
  60.                 CLOCK           Defaults are:
  61.                                         location:   upper right of screen;
  62.                                         attributes: digits          = 9,
  63.                                                     colons and "?m" = 4
  64.  
  65.        Subsequent invocations:
  66.  
  67.                 CLOCK           [no parameters; turns time display on]
  68.             or  CLOCK -<param>, where the parameter (singular !) can be :
  69.  
  70.                         N       [turns time display off]
  71.  
  72.                         Y       [turns time display on]
  73.  
  74.                         Ahh,ii  [changes attributes to
  75.                                         hh(digits), ii(colons and "?m")
  76.                                  where hh, ii = 2-digit hex]
  77.  
  78.                         A?      [writes "CLOCK -Ahh,ii" to stdout]
  79.  
  80.                         Ldd,ee  [changes location to
  81.                                         dd(row, 0-24),  ee(column, 0-79)
  82.                                  where dd, ee = 2-digit decimal]
  83.  
  84.                         L?      [writes "CLOCK -Ldd,ee" to stdout]
  85.  
  86.  
  87.  
  88.        If any other parameter is given, CLOCK writes its syntax (including
  89.        the hotkey !) to stdout.
  90.        Thus,
  91.  
  92.                 CLOCK ?
  93.  
  94.        provides a crib-sheet.
  95.  
  96. 
  97.  
  98.  
  99.  
  100.      Examples of Use
  101.      ───────────────
  102.  
  103.        For the palette-conscious, the -A? and -L? parameters can be used
  104.        to control and restore the colors and location of the displayed
  105.        time.  The following batch file, SAVCLOCK.BAT, redirects the output
  106.        of "CLOCK -A?" and "CLOCK -L?" to another batch file,
  107.        C:\RSTCLOCK.BAT:
  108.  
  109.                 echo off
  110.                 clock -L?  >C:\RSTCLOCK.BAT
  111.                 clock -A? >>C:\RSTCLOCK.BAT
  112.  
  113.  
  114.        Note that CLOCK's responses to the "?" parameters are precisely
  115.        the CLOCK commands necessary to restore CLOCK's state (location
  116.        or attributes) to that currently obtaining.  For instance, running
  117.        the above batch file immediately after installing CLOCK would cause
  118.        C:\RSTCLOCK.BAT to contain the commands:
  119.  
  120.                 CLOCK -L00,69
  121.                 CLOCK -A09,04
  122.  
  123.        Subsequently executing C:\RSTCLOCK would restore this location and
  124.        these attributes.
  125.  
  126.  
  127.        Suppose an application called APP uses the upper right corner
  128.        of the screen, and does not use the 11 columns starting at column
  129.        63 of the next line (line 1, with line 0 being the top line).
  130.        Suppose furthermore that APP displays other information in this area
  131.        of the screen in bright white on a blue background.  Suppose that
  132.        when in APP, you would like the time displayed at line 1, column 63,
  133.        using bright white for the digits and red for the ":"s and "?m" on
  134.        a blue background.  In a batch file that runs APP, the following
  135.        sequence of commands could then be used to ensure that the time will
  136.        always be displayed where you want it and how you want it:
  137.  
  138.  
  139.                 echo off
  140.                 ...
  141.                 command /c savclock
  142.                 CLOCK -L01,63
  143.                 CLOCK -A1F,14
  144.  
  145.                 APP
  146.                 ...
  147.                 command /c rstclock
  148.                 ...
  149.  
  150. 
  151.  
  152.  
  153.  
  154.      Limitations
  155.      ───────────
  156.  
  157.  
  158.        A few of CLOCK's current limitations - or, less charitably,
  159.        shortcomings - should be mentioned.  Currently, CLOCK cannot
  160.        display on lines below the 25th (e.g., the bottom of the screen
  161.        in EGA 43-line mode).  It will only display on page 0.  Neither
  162.        of these limitations are in fact much of a hindrance.  Also, the
  163.        displayed time is refreshed on every timer tick, and there is
  164.        presently no way to specify a greater number of ticks between
  165.        screen-writes.  NO checking is performed for adapters that "snow";
  166.        if you are using an IBM CGA, the display might prove irritating.
  167.  
  168.  
  169.  
  170.      Suggestions, Bug Reports
  171.      ────────────────────────
  172.  
  173.  
  174.        Suggestions for enhancements to CLOCK or to its documentation, and
  175.        reports of bugs or anomalies, should be communicated to the author:
  176.  
  177.                 Brian O'Neill Compuserve [72617,1541]
  178.  
  179.  
  180. 
  181.  
  182.  
  183.      License
  184.      ───────
  185.  
  186.  
  187.        This program, CLOCK.COM, and its accompanying documentation are
  188.        copyright (C) 1988 of the author, Brian O'Neill.
  189.  
  190.        You are hereby licensed to use this program on any number of computers
  191.        simultaneously; and to distribute the program together with its
  192.        documentation (this document), either by copying them to storage media
  193.        or by telecommunicating them.
  194.  
  195.        You are expressly prohibited, however, from distributing the program
  196.        without an unaltered copy of this document; and from distributing an
  197.        altered version of the program together with this document, without
  198.        also distributing, along with the altered program and unaltered
  199.        documentation, a separate document stating the nature of the
  200.        alteration to CLOCK.COM and identifying the party or parties
  201.        responsible for said alteration(s).
  202.  
  203.        Non-profit organizations are prohibited from charging any fee for
  204.        distributing the program and its documentation that exceeds by more
  205.        than $10 the currently prevailing cost of materials distributed.
  206.  
  207.        Neither the program nor its documentation may be included in any
  208.        commercial package whatsoever, without prior written consent of
  209.        the author.
  210.  
  211.        The author shall not be liable for any direct, indirect, consequential
  212.        or incidental damages resulting from, or seeming to result from, use
  213.        or distribution of the program.
  214.  
  215.        Use of this program constitutes agreement to the preceding seven
  216.        paragraphs, as well as to the proposition that by such use you become
  217.        bound to the terms of this agreement.